04. 提交说明

良好的提交说明

我们来思考一个问题：

如何编写良好的提交说明？为何要编写好的提交说明？

问的好！花点时间编写良好的提交说明，再怎么强调这一点都不为过。

何为好的提交说明呢？问的好，很多人发表过关于这一问题的文章，比如： 如何编写 Git Commit Message - 英 | 译文 、 Commit message 和 Change log 编写指南 。在编写好的提交说明时，需要注意以下几个事项：

建议

  • 消息篇幅简短（少于 60 个字符）

  • 解释提交的作用（不是如何更改或为何更改！）

禁忌

  • 请勿解释为何做出了这些更改（下文会深入讲解这一点）

  • 请勿解释如何进行了更改（这是 git log -p 的目的！）

  • 请勿使用单词"and"

  • 如果你必须使用 "and"，则你的提交说明可能进行了太多的更改，将这些更改拆分为独立的 commit

  • 例如 "make the background color pink and increase the size of the sidebar"

在编写提交说明时，我喜欢用以下短语造句："This commit will…"。你可以补充完整该句子并作为提交说明使用。

最重要的是，在编写提交说明时 保持一致性 ！

这是一条好的提交说明吗？

根据如何书写好的提交说明的相关指南，判断以下提交说明是否符合规范？

"Update the footer to copyright information"

SOLUTION: 是

这是一条好的提交说明吗？2

下面的提交说明符合规范吗？

"Add a

tag to the body"

SOLUTION: 否

这是一条好的提交说明吗？3

下面的提交说明符合规范吗？

"Add changes to app.js"

SOLUTION: 否

## 解释原因

如果你需要解释为何进行了提交，也可以！

在编写提交说明时，第一行是消息本身。消息之后空一行，然后输入正文或说明，包括关于为何需要该 commit 的原因详情（例如 URL 链接）。

以下是编辑提交说明时屏幕可能显示的内容：

_代码编辑器显示提交说明编辑窗口。输入了消息，接着空了一行，然后是对说明消息的描述。_

代码编辑器显示提交说明编辑窗口。输入了消息，接着空了一行，然后是对说明消息的描述。

提交说明的详情描述部分包含在 git log 中。要查看带有详情描述的提交说明，请参阅博客项目仓库并查看 commit 8a11b3f 。

但是 git log --oneline 中仅包含了说明（第一行）！

## 优达学城的提交样式要求

正如我之前提到的，编写提交说明的方式有多种。如果你属于某个团队，他们可能已经制定了提交说明编写方式。在优达学城，我们也有自己的提交说明标准。你可以参阅我们的 git 提交说明样式指南 。

如果你没有选择某种提交说明样式，可以使用我们的样式。但是如果你正在处理现有的项目，则使用他们的现有样式。与实际团队保持一致比与我们保持一致更为重要！

下一个是 git diff！

在下一部分，我们将学习一个新的工具（具有相似的输出！）。此工具可以在进行提交之前告诉我们已对文件进行了什么样的更改！

Next Concept